home *** CD-ROM | disk | FTP | other *** search
/ Amiga Magazin: Amiga-CD 1996 March / Amiga-CD 1996 #3.iso / amiga_technologies / include_i / libraries / amigaguide.i next >
Text File  |  1996-01-19  |  7KB  |  240 lines
  1.     IFND LIBRARIES_AMIGAGUIDE_I
  2. LIBRARIES_AMIGAGUIDE_I    SET    1
  3. **
  4. **    $VER: amigaguide.i 39.1 (13.8.92)
  5. **    Includes Release 40.16
  6. **
  7. **    C prototypes. For use with 32 bit integers only.
  8. **
  9. **    (C) Copyright 1990-1995 ESCOM AG
  10. **        All Rights Reserved
  11. **
  12.  
  13. ;------------------------------------------------------------------------------
  14.  
  15.     IFND EXEC_TYPES_I
  16.     INCLUDE "exec/types.i"
  17.     ENDC ;* EXEC_TYPES_I
  18.  
  19.     IFND EXEC_LISTS_I
  20.     INCLUDE "exec/lists.i"
  21.     ENDC ;* EXEC_LISTS_I
  22.  
  23.     IFND EXEC_NODES_I
  24.     INCLUDE "exec/nodes.i"
  25.     ENDC ;* EXEC_NODES_I
  26.  
  27.     IFND EXEC_SEMAPHORES_I
  28.     INCLUDE "exec/semaphores.i"
  29.     ENDC
  30.  
  31.     IFND INTUITION_INTUITION_I
  32.     INCLUDE "intuition/intuition.i"
  33.     ENDC
  34.  
  35.     IFND INTUITION_SCREENS_I
  36.     INCLUDE "intuition/screens.i"
  37.     ENDC
  38.  
  39.     IFND DO_DOS_I
  40.     INCLUDE "dos/dos.i"
  41.     ENDC
  42.  
  43.     IFND UTILITY_TAGITEM_I
  44.     INCLUDE "utility/tagitem.i"
  45.     ENDC
  46.  
  47.     IFND UTILITY_HOOKS_I
  48.     INCLUDE "utility/hooks.i"
  49.     ENDC
  50.  
  51. ;------------------------------------------------------------------------------
  52.  
  53.     IFND APSH_TOOL_ID
  54. APSH_TOOL_ID        equ    11000
  55. StartupMsgID        equ    (APSH_TOOL_ID+1)    ; Startup message
  56. LoginToolID        equ    (APSH_TOOL_ID+2)    ; Login a tool SIPC port
  57. LogoutToolID        equ    (APSH_TOOL_ID+3)    ; Logout a tool SIPC port
  58. ShutdownMsgID        equ    (APSH_TOOL_ID+4)    ; Shutdown message
  59. ActivateToolID        equ    (APSH_TOOL_ID+5)    ; Activate tool
  60. DeactivateToolID    equ    (APSH_TOOL_ID+6)    ; Deactivate tool
  61. ActiveToolID        equ    (APSH_TOOL_ID+7)    ; Tool Active
  62. InactiveToolID        equ    (APSH_TOOL_ID+8)    ; Tool Inactive
  63. ToolStatusID        equ    (APSH_TOOL_ID+9)    ; Status message
  64. ToolCmdID        equ    (APSH_TOOL_ID+10)    ; Tool command message
  65. ToolCmdReplyID        equ    (APSH_TOOL_ID+11)    ; Reply to tool command
  66. ShutdownToolID        equ    (APSH_TOOL_ID+12)    ; Shutdown tool
  67.     ENDC
  68.  
  69. ;------------------------------------------------------------------------------
  70.  
  71. ; Attributes accepted by GetAmigaGuideAttr()
  72. AGA_Dummy        equ    (TAG_USER)
  73. AGA_Path        equ    (AGA_Dummy+1)
  74. AGA_XRefList        equ    (AGA_Dummy+2)
  75. AGA_Activate        equ    (AGA_Dummy+3)
  76. AGA_Context        equ    (AGA_Dummy+4)
  77.  
  78. AGA_HelpGroup        equ    (AGA_Dummy+5)
  79.     ; (ULONG) unique window identifier
  80.  
  81. ;------------------------------------------------------------------------------
  82.  
  83.     STRUCTURE AmigaGuideMsg,0
  84.     STRUCT        agm_Msg,MN_SIZE            ; Embedded Exec message structure
  85.     ULONG        agm_Type;            ; Type of message
  86.     APTR        agm_Data;            ; Pointer to message data
  87.     ULONG        agm_DSize;            ; Size of message data
  88.     ULONG        agm_DType;            ; Type of message data
  89.     ULONG        agm_Pri_Ret;            ; Primary return value
  90.     ULONG        agm_Sec_Ret;            ; Secondary return value
  91.     APTR        agm_System1;
  92.     APTR        agm_System2;
  93.     LABEL AmigaGuideMsg_SIZEOF
  94.  
  95. ;------------------------------------------------------------------------------
  96.  
  97. ; Allocation description structure
  98.     STRUCTURE NewAmigaGuide,0
  99.     BPTR        nag_Lock            ; Lock on the document directory
  100.     APTR        nag_Name            ; Name of document file
  101.     APTR        nag_Screen            ; Screen to place windows within
  102.     APTR        nag_PubScreen            ; Public screen name to open on
  103.     APTR        nag_HostPort            ; Application's ARexx port name
  104.     APTR        nag_ClientPort            ; Name to assign to the clients ARexx port
  105.     APTR        nag_BaseName            ; Base name of the application
  106.     ULONG        nag_Flags            ; Flags
  107.     APTR        nag_Context            ; NULL terminated context table
  108.     APTR        nag_Node            ; Node to align on first (defaults to Main)
  109.     LONG        nag_Line            ; Line to align on
  110.     APTR        nag_Extens            ; Tag array extens
  111.     APTR        nag_Client            ; Private! MUST be NULL
  112.     LABEL NewAmigaGuide_SIZEOF
  113.  
  114. ; nag_Flags
  115.     BITDEF HT,LOAD_INDEX,0                ; Force load the index at init time
  116.     BITDEF HT,LOAD_ALL,1                ; Force load the entire database at init
  117.     BITDEF HT,CACHE_NODE,2                ; Cache each node as visited
  118.     BITDEF HT,CACHE_DB,3                ; Keep the buffers around until expunge
  119.     BITDEF HT,UNIQUE,4                    ; Unique ARexx port name
  120.     BITDEF HT,NOACTIVATE,5                ; Don't activate window
  121.  
  122. ;------------------------------------------------------------------------------
  123.  
  124. HTFC_SYSGADS        equ    $80000000
  125.  
  126. ;------------------------------------------------------------------------------
  127.  
  128. ; Callback function ID's
  129. HTH_OPEN        equ    0
  130. HTH_CLOSE        equ    1
  131.  
  132. ;------------------------------------------------------------------------------
  133.  
  134. ; Error message ID's
  135. HTERR_NOT_ENOUGH_MEMORY        equ    100
  136. HTERR_CANT_OPEN_DATABASE    equ    101
  137. HTERR_CANT_FIND_NODE        equ    102
  138. HTERR_CANT_OPEN_NODE        equ    103
  139. HTERR_CANT_OPEN_WINDOW        equ    104
  140. HTERR_INVALID_COMMAND        equ    105
  141. HTERR_CANT_COMPLETE        equ    106
  142. HTERR_PORT_CLOSED        equ    107
  143. HTERR_CANT_CREATE_PORT        equ    108
  144. HTERR_KEYWORD_NOT_FOUND        equ    113
  145.  
  146. ;------------------------------------------------------------------------------
  147.  
  148. ; Cross reference node
  149.     STRUCTURE XRef,0
  150.     STRUCT        xr_Node,LN_SIZE            ; Embedded node
  151.     UWORD        xr_Pad                ; Padding
  152.     APTR        xr_DF                ; Document defined in (not used)
  153.     APTR        xr_File                ; Name of document file
  154.     APTR        xr_Name                ; Name of item
  155.     LONG        xr_Line                ; Line defined at
  156.     LABEL XRef_SIZEOF
  157.  
  158. ;------------------------------------------------------------------------------
  159.  
  160. ; Types of cross reference nodes
  161. XR_GENERIC    equ    0
  162. XR_FUNCTION    equ    1
  163. XR_COMMAND    equ    2
  164. XR_INCLUDE    equ    3
  165. XR_MACRO    equ    4
  166. XR_STRUCT    equ    5
  167. XR_FIELD    equ    6
  168. XR_TYPEDEF    equ    7
  169. XR_DEFINE    equ    8
  170.  
  171. ;------------------------------------------------------------------------------
  172.  
  173. ; Callback handle
  174.     STRUCTURE AmigaGuideHost,0
  175.     STRUCT        agh_Dispatcher,h_SIZEOF        ; Dispatcher
  176.     ULONG        agh_Reserved            ; Must be 0
  177.     ULONG        agh_Flags            ; Control flags
  178.     ULONG        agh_UseCnt            ; Number of open nodes
  179.     APTR        agh_SystemData            ; Reserved for system use
  180.     APTR        agh_UserData            ; Application use
  181.     LABEL AmigaGuideHost_SIZEOF
  182.  
  183. ;------------------------------------------------------------------------------
  184.  
  185. ; Methods
  186. HM_FINDNODE    equ    1
  187. HM_OPENNODE    equ    2
  188. HM_CLOSENODE    equ    3
  189. HM_EXPUNGE    equ    10                ; Expunge DataBase
  190.  
  191.  
  192. ;------------------------------------------------------------------------------
  193.  
  194. ; HM_FINDNODE
  195.     STRUCTURE opFindHost,0
  196.     ; ULONG        MethodID
  197.     APTR        ofh_Attrs            ; R: Additional attributes
  198.     APTR        ofh_Node            ; R: Name of node
  199.     APTR        ofh_TOC                ; W: Table of Contents
  200.     APTR        ofh_Title            ; W: Title to give to the node
  201.     APTR        ofh_Next            ; W: Next node to browse to
  202.     APTR        ofh_Prev            ; W: Previous node to browse to
  203.  
  204. ;------------------------------------------------------------------------------
  205.  
  206. ; HM_OPENNODE, HM_CLOSENODE
  207.     STRUCTURE opNodeIO,0
  208.     ; ULONG        MethodID
  209.     APTR        onm_Attrs            ; R: Additional attributes
  210.     APTR        onm_Node            ; R: Node name and arguments
  211.     APTR        onm_FileName            ; W: File name buffer
  212.     APTR        onm_DocBuffer            ; W: Node buffer
  213.     ULONG        onm_BuffLen            ; W: Size of buffer
  214.     ULONG        onm_Flags            ; RW: Control flags
  215.  
  216. ; onm_Flags
  217.     BITDEF HTN,KEEP,0                    ; Don't flush this node until database is closed.
  218.     BITDEF HTN,RESERVED1,1                ; Reserved for system use
  219.     BITDEF HTN,RESERVED2,2                ; Reserved for system use
  220.     BITDEF HTN,ASCII,3                    ; Node is straight ASCII
  221.     BITDEF HTN,RESERVED3,4                ; Reserved for system use
  222.     BITDEF HTN,CLEAN,5                    ; Remove the node from the database
  223.     BITDEF HTN,DONE,6                    ; Done with node
  224.  
  225. ; onm_Attrs
  226. HTNA_Screen    equ    (TAG_USER+1)            ; Screen that window resides in
  227. HTNA_Pens    equ    (TAG_USER+2)            ; Pen array (from DrawInfo)
  228. HTNA_Rectangle    equ    (TAG_USER+3)            ; Window box
  229.  
  230. ;------------------------------------------------------------------------------
  231.  
  232. ; HM_EXPUNGE
  233.     STRUCTURE opExpungeNode,0
  234.     ; ULONG        MethodID
  235.     APTR        oen_Attrs            ; R: Additional attributes
  236.  
  237. ;------------------------------------------------------------------------------
  238.  
  239.     ENDC ;* LIBRARIES_AMIGAGUIDE_I
  240.